Skip to main content

Initiate EKYC

POST : http://<base_url>/digipay/v3/ekyc/initiate_verification_process

This API will be use to initiate verification process of e-kyc verification

BODY PARAMS:-

ParameterTypeDescriptionValue
kyc_wf_numberStringKyc Workflow number for ekyc flow.card_ke1
device_infoJsondevice key"device_type": 1
callback_urlStringurl to be used for callback to reflect the ekyc result.demo.digipay.com
redirection_urlStringurl to be used for redirection to origin.demo.digipay.com

HEADERS:-

ParameterTypeDescriptionValue
AuthorizationStringIt is a combination of type and token to authenticate user for the given tokenToken duik7309njdlkhdauhknksadhjkas986876sd873j
CompanyIDStringCompany_id is a unique primary id, that is represent company detail76bc712200ca444fa334f9e55e5fd7a8

Request Body:-

Request Example
curl --request POST \
--url https://192.168.1.102/digipay/v3/ekyc/initiate_verification_process \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '
{
"kyc_wf_number": "card_ke1",
"device_info": {
"device_type": 1,
"device_key": "metadata"
},
"callback_url": "demo.digipay.com",
"redirection_url": "demo.digipay.com"
}

Response:-

Response 200(OK)

{
"success": 1,
"error": [],
"data": {
"verification_url": "https://identity.digipay.guru/",
"verification_id": "4f5b616193784835b979c788d9ef5226"
}
}
Response 400(BAD REQUEST)
{
"success": 0,
"error"": [1],
"data": {
"message": "BAD_REQUEST",
}
}

RESPONSES :-

Status CodeDescription
200OK
400Bad Request
404Not Found
500Internal Server Error